home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Libris Britannia 4
/
science library(b).zip
/
science library(b)
/
COMMUNIC
/
NETWORKI
/
3692.ZIP
/
PROG-DOC.ZIP
/
DOC-PROC.MAN
next >
Wrap
Text File
|
1993-01-21
|
108KB
|
2,239 lines
The Doc-Proc Reference Manual
Version 1.1 March 01, 1993
Copyright 1993 CONNECT/Soft Publishing Co.
All Rights Reserved
CONNECT/Soft Publishing Co.
4247 Bingham Ct.
Stone Mountain, Georgia 30083
United States of America
Sole Proprietor:
John S. Ward
Table of Contents
Introduction ..................................... 1
Trademark Acknowledgements ....................... 3
Installation ..................................... 4
Program Requirements (Programmer) ................ 4
Program Requirements (User) ...................... 4
Distribution Files ............................... 5
Registration ..................................... 6
Shareware License ................................ 6
Shareware Warranty ............................... 6
Registered License ............................... 6
Registered Warranty .............................. 7
Registered Support ............................... 7
Frankness Clause ................................. 8
Disclaimer ....................................... 8
About Config.sys and Autoexec.bat ................ 8
Contacting the Author ............................ 8
Upgrade Policy ................................... 9
Script Syntax .................................... 9
Format of Script File ............................ 10
Script Tokens .................................... 13
CENTER ....................................... 13
COMMAND.COM .................................. 14
COMMENT ...................................... 15
DEST ......................................... 16
DIRECTORY .................................... 19
END .......................................... 20
GOODBYE ...................................... 20
MARGIN ....................................... 21
MENU1 ........................................ 21
MENU2 ........................................ 22
NETWORK ...................................... 23
SENTENCE ..................................... 24
SCRATCH-DRIVE ................................ 25
SKIP ......................................... 26
TITLE ........................................ 27
Script Debugging ................................. 28
Error Messages ................................... 28
Critical File Errors ......................... 29
Token Syntax Errors .......................... 31
Printer Errors ............................... 32
Miscellaneous Errors ......................... 33
Critical Hardware Errors ..................... 33
Preparing Documents for Doc-Proc ..................34
Preparing the News File for Doc-Proc ..............35
Registration ..................................... 35
The TEN Commandments ............................. 36
===========================================================================
Introduction
===========================================================================
Once upon a time I wrote a program that was (and is) distributed
nationwide. This program, like most, needs to be installed on the
customers' hard drives. I investigated every document processor
that I could find, and came away convinced that none of them had been
done very well. Under no circumstances could I justify $250, up to
$350, for any of them.
I wrote Doc-Proc.
Doc-Proc is a script driven professional On-line Information Retrieval
System that you as a programmer (or consultant) can use to categorize
documents in a manner that is easy to retrieve. These can be documents
used within a department or small business.
You as a programmer (or consultant) can install Doc-Proc on your
customer's computer and write your own token commands to tailor
Doc-Proc to fit your own applications or information bases. My
personal goal with this program was to develop a program that used,
as input, token commands to process document files in the most convenient
way possible. The procedure HAD to be configurable quickly and easily.
A brief list of features includes:
- Professional look and feel for a better first
impression.
- Comprehensive environment detection, including minimum
CPU, floating point processor, installed RAM, and MS-Dos
version.
- All Doc-Proc text strings may be optionally redefined
via an external file.
- Supports VGA/EGA 50/43 line text modes if detected.
- You customize your own titles for each of your screens.
- Doc-Proc is designed with user friendly Function keys that
allow you to have access to POP-UP HELP screens. Help screens
are available for each Menu panel.
- You optionally define the output destination for all documents.
If no output destinations are designated, a default list
of destinations will be generated on the Destination screen.
- You may specify a number of different printers for output
all of which could be connected to the same printer port
by using Network directives.
- You have the capability of specifying any Network or Dos
command before Doc-Proc processes any documents.
- Doc-Proc has a user interface that allows the user to issue
Network or Dos directives while while choosing a destination
option.
- Doc-Proc can process DOS text files as well as print files
generated from word processors or other programs.
- You define the Main menu panel by using category names
appropriate to the documents displayed in the sub-menus.
- You optionally define the headings for each sub-menu panel.
If no heading is designated for a sub-menu panel, Doc-Proc
will generate one using the name of the category from
the Main menu.
- You have the capacity to specify up to 18 different categories
on the main panel and up to 18 documents for each sub-menu.
This means it is possible to access a maximum number of 324
documents on-line. This, however, assumes that no titles
will be used on the menu panels. For every title line used
used to describe a menu panel, you have one less line on the
screen for a category or document name.
- Sub-menu panels are designed so that multiple documents
may be selected by separating each option number with a
comma.
- Doc-Proc has the capability to display all selected documents
on the terminal.
- Doc-Proc is equipped with a system news processor which allows
the administrator to place dated news on the system that may
be pertinent to the On-line documentation. A selection panel
allows one to view all news or only that news which is less
30 days old.
- Perhaps one of the most intriguing features attained by using
token directives, is that you have the flexibility of
allowing the Doc-Proc administrator to design the screens using
any language. For example: Spanish, French, English, and
German can be easily used without any modifications to the
source code.
Doc-Proc Reference Manual
- 2 -
- Robust error handling, including a custom critical error
handler that won't scare the dickens out of you.
As text from the MENU.FIL is read, it is scanned for
syntax errors. All syntax errors will be displayed on
the Product Banner screen. The line number in error will
be displayed along with a descriptive error message.
Doc-Proc will terminate until all syntax errors have been
corrected.
===========================================================================
Trademark Acknowledgements
===========================================================================
IBM - is a registered trademark of International Business
Machines Corporation.
MS-DOS - is a registered trademark of Microsoft, Inc.
CONNECT/Soft - is a trademark of CONNECT/Soft Publishing Co.
Doc-Proc Reference Manual
- 3 -
===========================================================================
Installation
===========================================================================
The installation procedure for Doc-Proc was designed to install Doc-Proc
and all associated files. The installation procedure will install the
Doc-Proc package on the C drive under the directory Doc-Proc. A
subdirectory will be created called DOC. This directory will contain
some sample documents to be used with Doc-Proc. It is recommended that
all documents to be used with Doc-Proc be placed under the DOC
subdirectory. The installation has been designed so that you may change
the installation default directories to whatever you wish. In order to
install the Doc-Proc package type INSTALL and follow the instructions.
===========================================================================
Program Requirements (Programmer)
===========================================================================
1. Text editor for creating and modifying the script file(s).
This text editor must not insert tab characters into your
screen definition lines.
2. MS-Dos 3.0 or higher.
3. IBM PC BIOS compatible MS-Dos computer with at least 200k
free RAM.
4. Standard CGA or Hercules compatible video subsystem.
===========================================================================
Program Requirements (User)
===========================================================================
1. MS-DOS 3.0 or higher.
2. IBM PC BIOS-compatible MS-DOS computer with 200k free RAM
(more RAM needed for RUN commands)
3. Standard CGA or Hercules compatible video subsystem.
Doc-Proc Reference Manual
-4-
===========================================================================
Distribution Files
===========================================================================
Doc-Proc comes distributed with the following files:
DOC-PROC.ZIP - A zipped version of all of the files listed
below. This format is maintained for the
convenience of Bulletin Board users.
INSTALL.EXE - The Installation program.
DOC-PROC.EXE - The Doc-Proc executable program.
DOC-PROC.MSK - Mask library for screen interface.
DOC-PROC.MAN - This reference manual.
MENU.FIL - Sample script used to demonstrate Doc-Proc.
(A number of sample DOS text files are provided
to be used with the sample script file)
ORDER.DOC - Order form.
README.DOC - Quick hello.
WHATS.NEW - Program fixes to bugs and new enhancements.
VENDOR.DOC - Ten line description of Doc-Proc. Disk vendors
may use this as a brief description to advertise
Doc-Proc.
If any of these files were missing, feel free to down-load the latest
version from the CONNECT/Soft On-line. Also, when you distribute
Doc-Proc with your applications, feel encouraged to rename it to what
ever you wish to call it.
Doc-Proc Reference Manual
-5-
===========================================================================
Registration
===========================================================================
Upon receipt of the registration price of $50.00 (U.S. funds only) you
will be sent a disk with the most current version that will enable you
to use the package without displaying my shareware notice. Use
the file "order.doc" to order. Sorry, MC/Visa not accepted.
===========================================================================
Shareware License
===========================================================================
You are free to distribute shareware copies of Doc-Proc provided
that none of the included files are modified or removed, and provided
that no additional files are included in the archive. Modifying the
archive format (from .zip to some other format perhaps more
convenient) is permitted.
===========================================================================
Shareware Warranty
===========================================================================
The shareware version of Doc-Proc is guaranteed to take up disk
space. The author of this product is more than happy to hear about any
bugs or unexpected behavior through non-voice channels (netmail, US
Postal Service, or logging on to the CONNECT/Soft BBS), but will not
guarantee that immediate bug fixes will be forthcoming.
===========================================================================
Registered License
===========================================================================
You are free to make unlimited backup copies of this program for
archival purposes. You may not distribute copies of this program
except under the following provisions: You may at your choosing give
away or sell your program with its accompanying files to ONE party,
provided you destroy all copies of the software in your possession
after the time of the transaction. The copies of the program that are
used to install your applications MUST NOT be distributed with the key
that enables script modifications.
Pursuant to United States copyright laws and international copyright
agreements, Doc-Proc must be treated as if it were a book. Just
as two people cannot read a book in front of separate computers, two
people must not simultaneously use the same registered copy of
Doc-Proc. The sole purpose of archival copies of Doc-Proc is
to be for protection against hardware or diskette failure.
Doc-Proc Reference Manual
- 6 -
===========================================================================
Registered Warranty
===========================================================================
The registered version (original copy) is warranted to meet in all key
aspects its defined behavior as listed in the documentation. Key
aspects are those features without which the program will fail in some
gross manner to perform as desired. Minor specifications (such
as prompt lengths, etc.) are subject to change without notice. The
final arbiter as to the interpretation of the documentation shall be
the author of the program. The sole remedy available to the purchaser
of Doc-Proc shall be bug fixes or a refund, as determined by the
author. Work-arounds (eg syntax modifications) for the purposes of
warranty consideration will be considered acceptable if they make
possible the same task that any bug renders impossible. If verified
bugs are not corrected within 30 days of notification, and if the
purchaser is working in good faith to keep in contact with the author,
the purchaser at his option is entitled to a refund. Verified bugs are
those which the author is able to duplicate on machines that fall
within the equipment requirements list.
Upgraded versions of Doc-Proc will be handled in a slightly
different fashion. Unless demonstrated otherwise, it is assumed by
the author that free upgrades obtained by the purchaser are so
obtained as a matter of the purchaser's convenience, and it is thus
assumed that the original, purchased copy of Doc-Proc is not
defective. It is further assumed that if a bug is discovered in a
free upgrade, the purchaser is still able to use his older version of
Doc-Proc. Therefore, unresolved bugs found in a free upgrade of
Doc-Proc are not subject to a refund of monies paid should such
bugs remain unresolved after 30 days. Any bugs found should still be
reported to the author, as he will give all bug reports due attention
in his attempts to resolve them.
There is one exception to this previous provision. If the author
represents an upgrade as a fix to a bug reported by the purchaser,
then the full original warranty shall be extended to cover the
upgrade.
===========================================================================
Registered Support
===========================================================================
The registered version entitles the purchaser to unlimited support via
netmail, the CONNECT/Soft BBS or via US Mail. I am unable, however, to
provide telephone support.
Doc-Proc Reference Manual
-7-
===========================================================================
Frankness Clause
===========================================================================
As you well know, it's darned difficult to get a publisher to stand
behind his product. He usually guarantees the diskette (what a joke)
and hangs you out to dry. If there is an error in the program, I will
do anything possible to correct it in a timely fashion. I am also
very interested in any ambiguities or errors in this documentation.
Whatever problems you do find, I would appreciate a note.
===========================================================================
Disclaimer
===========================================================================
While every effort has been made by the author to ensure the fitness
for use and integrity of Doc-Proc, the author cannot and will not
accept responsibility for any damage, physical or otherwise, to any
equipment owned by the purchaser. The author habitually recommends
that all customers back up their data regularly and frequently; that
recommendation applies here as well. The maximum remedy available to
the purchaser in the event of any type of dispute is the purchase cost
of the software.
===========================================================================
About the Autoexec.bat file
===========================================================================
Since the On-line Document Information Retrieval System is installed
under a directory called Doc-Proc, you may want to modify your
Autoexec.bat file so that the operating system is able to execute
the program without having to be under the directory. In order to
do this, you may modify your path command by concatenating the
directory Doc-Proc at the end of the PATH command. Remember to separate
the last directory with a semicolon.
===========================================================================
Contacting the Author
===========================================================================
If you have any questions concerning the workings of this product
you may contact me at the following mailing address:
JOHN S. WARD
4247 Bingham Ct.
Stone Mountain, Georgia 30083
United States of America
Any response sent to this address will receive a prompt response.
Doc-Proc Reference Manual
- 8 -
The following steps will greatly aid technical support and speed of
problem resolution:
1. If a specific command is not working as expected, does your
usage of the command comply with its description in the
appropriate section of the documentation?
2. To avoid my needing to resort to guesswork, send the exact
script that is not working for you with your question.
3. If logging onto the CONNECT/Soft On-line for technical support,
prepare your message in advance. The Message Menu of the BBS
has an Upload feature that will allow you to upload your
message with most any protocol. This will greatly reduce
connect time and increase accuracy. Be sure to include your
entire script as part of the message, or as its own message.
4. Be sure to indicate exactly which error messages, if any, are
accompanying unexpected behavior.
===========================================================================
Upgrade Policy
===========================================================================
"Once bought, always bought." Purchasers of Doc-Proc will be
entitled to free upgrades indefinitely. I will notify you of the
first significant upgrade of Doc-Proc after registration, and I
keep the current registered version of Doc-Proc available for
download in the 'Registered User' file section of the CONNECT/Soft On-line.
===========================================================================
Script Syntax
===========================================================================
When Doc-Proc.exe is executed, the first file it looks for is a file
called MENU.FIL in the same directory as Doc-Proc. If MENU.FIL is
not available, the program terminates. If MENU.FIL is processed
successfully, processing continues until the token command END has been
encountered in the current script or an end-of-file is reached. Once
all token commands have been processed successfully, panel screens
will be displayed for option selections.
Before beginning immediately with the syntax proper, an explanation of
how Doc-Proc functions is in order:
If the script DEST, a token command for output destination, is missing,
a default list of output destination options will be displayed on
the Destination panel. If menu headings are missing for the MENU2
token command, a MENU2 heading will be constructed from the category
name used with the token command MENU1.
Doc-Proc Reference Manual
- 9 -
===========================================================================
Format of Script File
===========================================================================
MENU.FIL
--------
The following is a brief overview of the syntax needed for MENU.FIL:
COMMENT "Sample MENU.FIL setup to drive Doc-Proc"
SCRATCH-DRIVE = DRIVE: Scratch drive used for Doc-Proc scratch files.
If no Scratch drive is specified, the default
drive is used.
COMMAND.COM PATH = Drive: directory path in which a copy of
COMMAND.COM resides.
DIRECTORY Drive: directory path for which document files reside.
TITLE "User banner goes here"
DEST
SKIP 1
CENTER "Destination title goes here"
CENTER "Additional destination title goes here"
DEST "Destination description"
DEST [printer dest.] [network directive] <print file qualifier>
MENU1
SKIP 1
CENTER "MENU1 category titles here"
CENTER "Additional MENU! category titles here"
SKIP 1
MENU1 "Name of 1st category"
MENU2
CENTER "MENU2 screen title here"
CENTER "Additional MENU2 screen titles here"
SKIP 1
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU1 "Name of 2nd category"
MENU2
CENTER "MENU2 screen title here"
CENTER "Additional MENU2 screen titles here"
SKIP 1
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
MENU2 "Name of document" "Document name on disk" #pages last-update
SKIP 2
GOODBYE "So-long text goes here"
GOODBYE "Additional GOODBYE lines go here"
END
Doc-Proc Reference Manual
- 10 -
In the above example, the order that the tokens appear is the most
logical, but is not strictly required. The following is a list of
token order requirements:
1. The COMMENT token may be used anywhere within the MENU.FIL
to document and or COMMENT out existing COMMAND tokens.
2. The SCRATCH-DRIVE then should be used at the beginning of
the MENU.FIL but is not confined to any precedence order
and may be used anywhere in the MENU.FIL. Absence of this
command assumes the default drive for any Doc-Proc
scratch files. Many networks have write protected file
servers. This token command may be used to direct all
scratch files to a server or drive that is not write
protected.
3. The COMMAND.COM token command should be used at the
beginning of the MENU.FIL to improve readability but will
function correctly when used anywhere in the Job stream.
This token command is very important when operating Doc-Proc
on a system that does not have a copy of COMMAND.COM in the
root directory.
4. The DIRECTORY token may be used to specify the directory
from which documents may be found. This feature enables
one to have more space available on the MENU2 token command
line. The DIRECTORY token may be used to reduce the
redundancy of specifying directories for a number of
documents residing under the same directory. Any directory
information specified using the MENU2 token command will
take precedence over the directory information specified
on the DIRECTORY token command.
5. TITLE tokens must appear before any other menu panels are
constructed. The TITLE token should appear before any
DEST, MENU1 or MENU2 token. CENTER, SENTENCE, and SKIP
tokens may be used in conjunction with TITLE tokens.
6. The DEST token used to define a panel of document destination
selections should logically follow the TITLE tokens since this
is the next screen that will be displayed after the user banner
screen. CENTER, SENTENCE and SKIP tokens may be used in
conjunction with DEST tokens. If one wants to utilize the
default destination panel, leave this command out of the
MENU.FIL.
Doc-Proc Reference Manual
- 11 -
7. The MENU1 token must precede a MENU2 token. If no MENU2 token
precedes a MENU1 token, a sub-panel for that MENU1 token will
not be created. In other words you will have an entry for a
category but no document names will be displayed when the
user chooses that category. The absence of a MENU2 token will
not generate an error message as to allow for user flexibility
in building panels. CENTER, SENTENCE and SKIP tokens may
be used in conjunction with the MENU1 token command so that
a title may be constructed for the category panel.
8. The MENU2 token directive must follow a MENU1 token directive.
This token is used to build the panel which contains the names
of the documents that will be associated with a selected
category. The document information for each MENU2 token
directive will be associated with the last MENU1 token
directive. CENTER, SENTENCE and SKIP tokens may be used in
conjunction with the MENU2 token command so that a title
may be constructed for the document panel. If neither one
of these tokens is used, a default title will be constructed
using the name of the category from MENU1.
9. The GOODBYE token should follow all previously used tokens.
This token is used to build a screen which displays a final
message before the program terminates. CENTER, SENTENCE and
SKIP tokens may be used in conjunction with the GOODBYE token
command. This is an optional token and may be left out of
the token job stream if you wish.
10. The END token may be used anywhere in the program. It simply
terminates all token processing at the point at which the token
command is scanned. Most of the time the END token will be
the very last token used in the job stream. If no END token
is used Doc-Proc will look for an end-of-file marker before
terminating its token scan.
Doc-Proc Reference Manual
- 12 -
===========================================================================
Script Tokens
===========================================================================
All Script tokens should be placed in a file named MENU.FIL.
This file should be a standard ASCII text file with a record
length of 80 bytes.
CENTER
------
Syntax:
CENTER "Any text enclosed in quotes"
Example:
CENTER "THIS IS A LIST OF CATEGORIES ON OUR NETWORK"
The Center token may be used to center a string of text up to 70
characters long. This command may be used in conjunction with the
following token directives:
1) DEST - token directive for the Destination panel.
2) MENU1 - token directive for the Primary menu panel.
3) MENU2 - token directive for the Document panel.
Once any one of these token directives have been issued, You may use
the CENTER token command to center designated text for each of the
above panels. Up to 70 characters of text are allowed with the CENTER
token command. If the particular text used creates unbalanced sides,
insert an extra space on the errant side to even things out.
Any one of the above token directives may be issued before the CENTER
token command to designate the appropriate panel for which the text
is to be centered.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
Doc-Proc Reference Manual
- 13 -
COMMAND.COM
-----------
Syntax:
COMMAND.COM PATH = Drive: directory path in which a copy of
COMMAND.COM resides.
Example:
COMMAND.COM PATH = F:\PUBLIC\DOS\IBM\V5.00
The COMMAND.COM token is used to tell DOC-PROC where to obtain a copy
of your COMMAND.COM. DOC-PROC needs a copy of COMMAND.COM when issuing
any Network or DOS directive. If the token command COMMAND.COM is not
found in the file MENU.FIL, DOC-PROC will look for a copy of COMMAND.COM
in DOC-PROC's root directory. If you have installed Doc-Proc on your
C drive, there should be a copy of COMMAND.COM in your root directory
since the DOS operating system environment is usually installed on your
C drive.
If you have installed Doc-Proc on a Network file server, keep in mind
that many Networks do not maintain a copy of COMMAND.COM in the root
directory. If this is the case, use the token command COMMAND.COM to
direct DOC-PROC to the appropriate drive and directory. The drive must
be specified along with the directory.
When specifying the drive and directory you are allowed up to a maximum
of 60 characters. If your directory path exceeds this length, you will
experience a truncation problem.
This token command may be used anywhere in the MENU.FIL. It must
however, precede any token directives that rely on Network or DOS
directives.
If the equal sign does not follow the path directive, or the drive
followed by a colon is not specified, an error message will be displayed
on the Product Banner screen and processing will be terminated.
Doc-Proc Reference Manual
- 14 -
COMMENT
-------
Syntax:
COMMENT Any text following the COMMENT token.
Example:
COMMENT THE DOC-PROC TOKEN CONTROL LANGUAGE
COMMENT WAS MODIFIED 06/15/93
The COMMENT token is used to internally document your token directives.
Any text preceded with the COMMENT token is ignored when the program
builds the panels for the various menus. The COMMENT command must be
followed by one or more spaces. This command may be used anywhere
in your job stream. Use of this command to document other token
directives makes the job stream more readable.
Doc-Proc Reference Manual
- 15 -
DEST
----
Syntax:
1) DEST
2) DEST "Text"
DEST "Text"
3) DEST "Text" [printer dest.]
DEST "Text" [printer dest.] [network directive] <print file qualifier>
4) DEST [printer dest.]
DEST [printer dest.] [network directive]
DEST [printer dest.] <print file qualifier>
DEST [printer dest.] [network directive] <print file qualifier>
The following reserved Printer destinations may be used:
PRN - Sends output to COMM port 1.
LPT1 - Sends output to COMM port 1.
LPT2 - Sends output to COMM port 2.
LPT3 - Sends output to COMM port 3.
TERMINAL - Sends output to the terminal to be viewed on
your screen.
Example:
DEST " 2) HEWLETT PACKARD "
DEST [LPT1] [CAPTURE QUEUE=HPLJ2 S=CCLAB] <F:\DOCUMENTS\HP\STATPLUS\.LJ2>
The DEST token is used to build the Destination panel. This panel
allows the user to choose a print destination for those documents
that are selected.
1) The DEST command may be used without any parameters. This will
enable you to use other token commands, such as CENTER and SENTENCE,
to build a title for the Destination panel.
2) The second form of the DEST command allows you to have multiple lines
of text to describe a single printer destination.
3) The third form of the DEST command use brackets as delimiters for the
printer destination and network directive. Less than and greater
than symbols are used in specifying a directory and or print file
qualifier used to locate a print file for a designated printer
destination.
Doc-Proc Reference Manual
- 16 -
A print file name will be constructed using the print file drive
and directory concatenated with the name of the DOS text file
name found on the MENU2 token command and the name will be suffixed
with the print file qualifier.
FOR EXAMPLE:
DEST " 2) HEWLETT PACKARD "
DEST [LPT1] [CAPTURE QUEUE=HPLJ2 S=CCLAB] <F:\DOCUMENTS\HP\STATPLUS\.LJ2>
MENU2 "STAT PLUS " "F:\DOCUMENTS\STATPLUS.DOC" 27 09/23/93
If one were to choose option 2 of the Destination panel followed
by the selection option for STATPLUS, the print file name
F:\DOCUMENTS\HP\STATPLUS.LJ2
would be constructed.
When the STATPLUS document is selected to be printed, Doc-Proc would
look for this file name on disk. If the print file does not exist,
Doc-Proc will proceed to print the ASCII DOS text version of the
document which would be
F:\DOCUMENTS\STATPLUS.DOC
4) The fourth form of the DEST command are different variations using
the DEST command for printer destinations, network directives, and
print file qualifiers.
When specifying a network directive, it must always follow a printer
destination.
Option numbers displayed on the Destination panel will correspond
to the order of the printer destinations specified in the Job stream.
For each printer option to be displayed, you should specify an
option number as part of the string literal.
The printer destinations will be stored in a vector starting with
an assigned number of 1 and continuing until the last printer
destination has been scanned.
Network directives are optional. They allow the user of the program
to be able to choose a specific printer both of which may be accessed
by way of the same printer port. Most of the time a network directive
will not be necessary.
Doc-Proc Reference Manual
- 17 -
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
If brackets are omitted for print destinations or network directives,
an error message will be displayed on the Product Banner screen and
processing will be terminated.
If the delimiters around the print file qualifier are missing, an error
message will be displayed on the Product Banner screen and processing
will be terminated.
Doc-Proc Reference Manual
- 18 -
DIRECTORY
---------
Syntax:
DIRECTORY Drive: directory path in which document files reside
Example:
DIRECTORY F:\PUBLIC\DOC-PROC\DOC\
The Directory token script is used to specify a directory and its
associated subdirectories. The directory designation has two
requirements:
1) The drive must be specified and followed by a semicolon.
2) The last subdirectory ends with a back slash.
The Directory token may be used to concatenate a drive and directory
to a file name specified on the MENU2 token command. By using the
Directory token to specify a directory, you can save space when
designating a file name on the MENU2 token command. This provides more
room on the MENU2 token command to describe the document type. If the
drive is given as part of the file name specified on the MENU2 token
command, directory information from the Directory token command will
not be concatenated.
The Directory token thus allows you to specify a directory for a number
of documents while at the same time the Directory token command may be
overridden from the MENU2 token command by specifying a drive with the
file name.
This feature thus allows you to specify a directory under which many of
the documents reside and at the same time allows for the flexibility
of specifying documents residing under different directories.
A sample token job stream using the DIRECTORY token follows:
DIRECTORY F:\PUBLIC\DOC-PROC\DOC\
MENU1 "COMPILER LANGUAGES"
MENU2 "COBOL" COBOL.DOC 008 12/04/93
MENU2 "FORTRAN" FORTRAN.DOC 006 12/09/93
MENU2 "PASCAL" PASCAL.DOC 005 11/24/93
MENU1 "DATABASE LANGUAGES"
MENU2 "DBASE" D:\DATABASE\DOC\DBASE.DOC 010 12/14/93
MENU2 "PARADOX" D:\DATABASE\DOC\PARADOX.DOC 022 10/21/93
END
Doc-Proc Reference Manual
- 19 -
END
---
Syntax:
END
Example:
END
The END token is used to terminate script token processing. This token
directive may be placed anywhere in the token command stream.
When the Doc-Proc processor processes this command, all other token
commands following the END token are ignored. If no syntax errors are
found on those token commands prior to the END command, Doc-Proc will
proceed to prompt for destination and menu panel options. Using this
token directive is entirely optional. Without this token directive,
the Doc-Proc processor will continue processing token scripts until
it reaches end-of-file.
GOODBYE
-------
Syntax:
GOODBYE
GOODBYE "Text enclosed in quotes"
Example:
GOODBYE "YOU ARE NOW FINISHED USING THE Doc-Proc system"
The GOODBYE token script is used to display an optional panel when
the Doc-Proc program terminates. This may be used to tell the end user
what to do once he/she has finished using the Doc-Proc processor.
The GOODBYE command may be used without any parameters. This will enable
you to use other token commands, such as the SENTENCE token, to help build
a GOODBYE panel. If the GOODBYE token is not used, the program
terminates without this additional screen.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
Doc-Proc Reference Manual
- 20 -
MARGIN
------
Syntax:
MARGIN
MARGIN margin-width
EXAMPLE:
MARGIN 4
The MARGIN command may be used to designate a left margin width for
all the documents selected for printing. If the MARGIN command is
used without a designated margin-width, the margin-width is assumed
to be 1. Use of the MARGIN token will cause Doc-Proc to be slower
when printing documents. The MARGIN command may not be used to adjust
the margin-width of existing print files.
MENU1
-----
Syntax:
MENU1
MENU1 "Text enclosed in quotes"
Example:
MENU1 "STATISTICAL PACKAGES"
The MENU1 token is used build the Main Menu panel. This panel allows
the user to choose a category of documents to be viewed.
The MENU1 command may be used without any parameters. This will enable
you to use other token commands, such as CENTER and SENTENCE, to build
a title for the Main Menu panel.
The second form of the MENU1 command is used to build a menu selection
panel of categories. Option numbers will be automatically generated
for each category entry. The order for each entry displayed on the
screen will be the same as the order found in the Job stream of
token commands.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
Doc-Proc Reference Manual
- 21 -
MENU2
-----
Syntax:
MENU2
MENU2 "Document type" "Document name on disk" number-of-pages last-update
Example:
MENU2 "STAT PLUS " "F:\DOCUMENTS\STATPLUS.DOC" 27 09/23/93
MENU2 "STAT PLUS " "F:\DOCUMENTS\STATPLUS.PRN" 27 09/23/93
The MENU2 token is used to build the selection panels for each
category of the Main Menu. Each of these panels allows the user
to select a document to be viewed at the screen or sent to a print
destination.
The MENU2 command may be used without any parameters. This will enable
you to use other token commands, such as CENTER and SENTENCE, to build
a title for the Main Menu panel.
The second form of the MENU2 command is used to build a selection of
documents for each category designated by the MENU1 command. The drive
specification may or may not be present as a part of the "Document name
on Disk". If the drive specification does not exist, a drive and
Directory designation may be defined using the Directory token command.
If no Directory token was used, Doc-Proc will look for the document
under the current default drive.
In the example above, the document for STATPLUS is processed differently
depending on the extension suffix on the file name. If the document
has an extension of '.PRN' Doc-Proc treats the document as a print file
and does not number and paginate each page. For all other cases,
Doc-Proc will number and paginate the document.
Option numbers are displayed on the screen for each document name.
The order for each entry will be the same as the order found in the
Job stream of token commands.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
Doc-Proc Reference Manual
- 22 -
NETWORK
-------
Syntax:
NETWORK "Text enclosed in quotes"
Example:
NETWORK "CAPTURE QUEUE=HPLJ2 S=CCLAB1"
The NETWORK may be used to issue NETWORK or DOS directives. This token
command will probably be the least used of the token commands. It has
been made available if the need for this type of command ever arises.
Most of the NETWORK routing commands will be used in conjunction with
the DEST token command.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
Doc-Proc Reference Manual
- 23 -
SENTENCE
--------
Syntax:
SENTENCE "Any text enclosed in quotes"
Example:
SENTENCE " LIBRARY SOUTH ROOM 107"
The Sentence token may be used to display unaltered string literals
for a number of select panels. This command may be used in conjunction
with the following token directives:
1) TITLE - token directive for the User Banner panel.
2) DEST - token directive for the Destination panel.
3) MENU1 - token directive for the Primary menu panel.
4) MENU2 - token directive for the Document panel.
Once any one of these token directives have been issued, you may use
the SENTENCE token command to place a string of text in any of the
above panels. Up to 70 characters of text are allowed with the SENTENCE
command token.
Any one of the above token directives may be issued before the SENTENCE
token command to designate the appropriate panel for which the text
is to be placed.
If quotes are omitted, an error message will be displayed on the
Product Banner screen and processing will be terminated.
Doc-Proc Reference Manual
- 24 -
SCRATCH-DRIVE
-------------
Syntax:
SCRATCH-DRIVE
SCRATCH-DRIVE disk-drive
EXAMPLE:
SCRATCH-DRIVE C:
The SCRATCH-DRIVE command may be used to designate a drive that
Doc-Proc may use for scratch files. If no SCRATCH-DRIVE command
token is used, Doc-Proc will use the current drive from which
Doc-Proc is invoked for all of its scratch files. Upon normal
termination from the program, all Doc-Proc scratch files are
erased. The SCRATCH-DRIVE command token may be used to direct
scratch files to another hard disk if Doc-Proc is installed on a
Network file server that has no write access privileges.
If the file drive is not a valid letter from A to Z, an error
message will be displayed on the Product Banner screen and
processing will be terminated. If the file drive is not followed
by a semicolon, and error message will be displayed on the Product
Banner screen and processing will be terminated.
Doc-Proc Reference Manual
- 25 -
SKIP
----
Syntax:
SKIP
SKIP number-of-lines-skipped
EXAMPLE:
SKIP 4
The SKIP command may be used to skip a designated number of lines
between lines of text. This command may be used in conjunction with
the following token directives:
1) TITLE - token directive for the User Banner panel.
2) DEST - token directive for the Destination panel.
3) MENU1 - token directive for the Primary menu panel.
4) MENU2 - token directive for the Document panel.
Once any one of these token directives have been issued, You may use
the SKIP token command to skip a designated number of lines. If the
SKIP command does not specify a number of lines to be skipped, a skip
value of 1 will be assumed.
Doc-Proc Reference Manual
- 26 -
TITLE
------
Syntax:
TITLE "Any text enclosed in quotes"
Example:
TITLE "GEORGIA STATE UNIVERSITY"
The TITLE token identifies the lines of text to be shown to the User
at the beginning of the program. This enables you to display an
organization or department name. All text for the User Title will
be display after the Product banner. Up to 70 characters are allowed
for each line of text. Each string of text that appears on the Title
screen will be centered. If the particular text used creates unbalanced
sides, insert an extra space on the errant side to even things out.
If quotes are omitted for a string of text, an error message will be
displayed on the Product Banner screen and processing will be
terminated.
If you wish text to appear on the Title screen without being centered,
the use the SENTENCE token command. You are allowed to use up to 20
lines of text on the TITLE screen. The SENTENCE token command will
process a string literal in its unaltered state.
Doc-Proc Reference Manual
- 27 -
===========================================================================
Script Debugging
===========================================================================
Before you release your customized version of Doc-Proc to your users,
you are going to want to make sure that the end product as you envision
it is actually going to happen. I have made a great effort to make all
error messages as descriptive as possible. In the cases of DOS returning
an error, the error message is given verbatim back to you. I
have taken great lengths to make the parser as smart as possible;
however, possible to make any parser look stupid with intentional or
lucky entries (just leave a terminating curly bracket off a c function
if you need proof.) If you follow the syntax closely, the parser will
make both Doc-Proc and your application look great. If you feel
that your syntax is correct, or should be, but the parser seems to
disagree with you, leave me a note through the channels described in
"Contacting the Author."
===========================================================================
Error Messages
===========================================================================
The following are the standard error messages built into Doc-Proc.
The nature of these errors is such that Doc-Proc cannot continue,
so these error messages can probably be classified as Fatal Errors.
Of course, the message the user sees doesn't include the word 'Fatal'
for obvious reasons.
Any application should be distributed with manual installation
instructions to help alleviate the unexpected, hence the wordage of
the error message. The documentation that you provide your users
should include a telephone number in case of installation
difficulties, or in case manual procedures also didn't succeed.
Doc-Proc Reference Manual
- 28 -
==========================================================================
Critical File Errors
==========================================================================
THE FOLLOWING KINDS OF OPEN ERRORS CAN OCCUR
AND RESULT IN ABNORMAL TERMINATION OF THE PROGRAM
*************************************************
1) Error opening MENU.FIL
MENU.FIL was not found in the same directory as Doc-Proc,
or there were no file handles available.
/ ============================================================ \
|| ||
|| The following unrecoverable error has occurred: ||
|| ||
|| Error opening MENU.FIL ||
|| ||
|| Please refer to your documentation for manual installation ||
|| instructions if the problem cannot be corrected. ||
|| ||
|| Press a key to terminate... ||
\ ============================================================ /
2) Error opening NEWS.FIL
NEWS.FIL was not found in the same directory as Doc-Proc,
or there were no file handles available.
/ ============================================================ \
|| ||
|| The following unrecoverable error has occurred: ||
|| ||
|| Error opening NEWS.FIL ||
|| ||
|| Please refer to your documentation for manual installation ||
|| instructions if the problem cannot be corrected. ||
|| ||
|| Press a key to terminate... ||
\ ============================================================ /
Doc-Proc Reference Manual
- 29 -
3) Error opening a document file.
A document was not found on the designated drive on the
your Network.
/ ============================================================ \
|| ||
|| The following unrecoverable error has occurred: ||
|| ||
|| Error opening "name-of-document" ||
|| ||
|| Most probable cause: Document named above could not be ||
|| found on Disk or Network. Check the name of the file. If ||
|| you still have problems, check syntax of the MENU2 token. ||
|| ||
|| Press a key to terminate... ||
\ ============================================================ /
4) Error accessing COMMAND.COM.
The COMMAND.COM file was not found under the root directory or
the token command COMMAND.COM specified an invalid path directory.
/ ============================================================ \
|| ||
|| The following unrecoverable error has occurred: ||
|| ||
|| ||
|| ||
|| The COMMAND.COM file could not be found. ||
|| ||
|| EITHER: ||
|| ||
|| 1) COMMAND.COM file was not found in Root directory. ||
|| 2) COMMAND.COM file was not found in the token ||
|| command COMMAND.COM PATH directory. ||
|| ||
|| Please refer to your documentation for instructions ||
|| in using the token command COMMAND.COM. ||
|| ||
\ ============================================================ /
Doc-Proc Reference Manual
- 30 -
==========================================================================
Token Syntax Errors
==========================================================================
COMMAND.COM command missing PATH directive.
COMMAND.COM command missing equal sign after PATH directive.
COMMAND.COM command missing drive designation on PATH directive.
DIRECTORY command missing SEMICOLON following drive designation.
DIRECTORY command does not end with a "\".
MARGIN command missing DOUBLE QUOTE MARKS.
TITLE command missing DOUBLE QUOTE MARKS.
TITLE command missing DOUBLE QUOTE MARK.
TITLE command has too many DOUBLE QUOTE MARKS.
CENTER command missing DOUBLE QUOTE MARKS.
CENTER command missing DOUBLE QUOTE MARK.
CENTER command has too many DOUBLE QUOTE MARKS.
SKIP command is missing valid numeric value.
SENTENCE command missing DOUBLE QUOTE MARKS.
SENTENCE command missing DOUBLE QUOTE MARK.
SENTENCE command has too many DOUBLE QUOTE MARKS.
DEST command missing DOUBLE QUOTE MARKS.
DEST command missing DOUBLE QUOTE MARK.
DEST command has too many DOUBLE QUOTE MARKS.
DEST command missing RIGHT BRACKET
DEST command missing LEFT BRACKET
DEST command has too many LEFT BRACKETS
DEST command has too many RIGHT BRACKETS
DEST command missing GREATER THAN BRACKET
DEST command missing LESS THAN BRACKET
DEST command has too many LESS THAN BRACKETS
DEST command has too many GREATER THAN BRACKETS
Print file qualifier on DEST command should be
suffixed with a PERIOD.
Drive designator missing on directory for
print file qualifier on DEST command.
Directory used with print file qualifier missing
slash before period of print file qualifier
used in DEST command.
Doc-Proc Reference Manual
- 31 -
NETWORK command missing RIGHT BRACKET
NETWORK command missing LEFT BRACKET
NETWORK command has too many LEFT BRACKETS
NETWORK command has too many RIGHT BRACKETS
MENU2 command has not been preceded by a MENU1 command.
MENU2 command missing DOUBLE QUOTE MARKS.
MENU2 command missing DOUBLE QUOTE MARK.
MENU2 command has too many DOUBLE QUOTE MARKS.
GOODBYE command missing DOUBLE QUOTE MARKS.
GOODBYE command missing DOUBLE QUOTE MARK.
GOODBYE command has too many DOUBLE QUOTE MARKS.
INVALID TOKEN COMMAND!
A token encountered on the indicated line in the script
was not a valid command.
==========================================================================
Printer Errors
==========================================================================
The following are a list of printer errors that may occur when using
Doc-Proc. These errors do not cause the Program to abnormally terminate.
Once the printer problem has been rectified Doc-Proc continues
processing.
1) PRINTER TIMEOUT
2) PRINTER I/O/ ERROR
3) PRINTER IS NOT ON-LINE
4) PRINTER IS OUT OF PAPER
5) PRINTER DID NOT ACKNOWLEDGE
6) PRINTER IS BUSY
Doc-Proc Reference Manual
- 32 -
==========================================================================
Miscellaneous Errors
==========================================================================
DOS version 3.0 or higher required
A DOS version prior to 3.0 was detected. Doc-Proc requires
MS-DOS 3.0 or later.
Token was expected but not found: line nn
A token was expected but not found on the indicated line. This
usually means that one or more words is missing on this line.
Memory allocation error
A request for more memory was denied. This is extremely
unlikely to occur, as Doc-Proc requires under 200k of free
RAM.
===========================================================================
Critical Hardware Errors
===========================================================================
Should a disk door be left open (or any other critical error trapped
by DOS, for that matter) a Critical Error handler built into
Doc-Proc will take control and provide the user with a menu similar
to this one:
/ ==========[DOS Critical Error]========= \
|| ||
|| [Abort] [Retry] [Ignore] [Fail] ||
|| ||
\ ======================================= /
If the user accepts retry, he will be in most cases safe. Of course,
if his computer picked the exact moment that he's installing your
application to crash its hard drive, no Critical Error handler is
going to recover very gracefully.
Doc-Proc Reference Manual
- 33 -
===========================================================================
PREPARING DOCUMENTS FOR DOC-PROC
===========================================================================
All documents processed by the Doc-Proc processor should be in standard
ASCII DOS text. Print files from other document processors may be used
in addition to the ASCII DOS text files by specifying a print file
qualifier on the DEST command. The ASCII DOS text file will be used
when the user views the document on the screen. If a print file exist
this will be used when choosing a printer destination.
If you wish to have a wider left margin on your documents, You may use
the MARGIN token command in the token job stream to attain the desired
margin width for the printed documents. This command may not be used
to adjust the margin of existing print files.
Use of this token command is not recommended as it generates additional
Central Processing Unit (CPU) overhead which slows down the printing
process.
A maximum of 55 lines of text may be printed for each page of text.
This limitation was established to permit automatic page numbering
at the bottom of each page. If you wish to have forced pagination
between text, you may use the word EJECT. This command must start
in column 1 and may be used anywhere within the text of your document.
Make sure that the record length for each document file is 80 bytes
long.
Doc-Proc Reference Manual
- 34 -
===========================================================================
PREPARING THE NEWS FILE FOR DOC-PROC
===========================================================================
A news file must be established before Doc-Proc will successfully
execute. If the NEWS.FIL does not exist under the same directory
as Doc-Proc, the program will generate an appropriate error message
and terminate.
Function key 'F4' is used as the key to display System news. Once
the System News panel is displayed, you are given a choice of two
options. You may display all of the news on the system or just that
news less than 30 days old. The NEWS.FIL is used to place news of
upcoming events within a department or it may be used to post
conference dates.
Each piece of news that is posted in the NEWS.FIL should be preceded
by the date the news was posted. For readability purposes and file
management, the news date should be on a line by itself. The news
date should start in column 1 with a 2 digit month followed by
a slash, a 2 digit day followed by a slash, and a 2 digit year.
EXAMPLE:
07/01/93
The XYZ corporation will be closed JULY 4, 1993.
09/01/93
There is a departmental meeting at 1:00pm 09/15/93 in
room 105. Attendance is mandatory.
The NEWS.FIL can be maintained by any ASCII text editor. Make sure
the record length for the file is 80 bytes long.
===========================================================================
Registration
===========================================================================
This section deals only with registered copies of Doc-Proc.
Shareware versions have no distribution protection built in
whatsoever.
With your registered Doc-Proc diskette you received the latest version
without the shareware notice on the Banner screen.
This protects my product, as well as protects your installation from
unwanted tampering.
Doc-Proc Reference Manual
- 35 -
==========================================================================
The Ten Commandments
==========================================================================
EXODUS 20
20 THEN GOD ISSUED this edict:
"I am Jehovah your God who liberated you from your slavery in Egypt.
"You may worship no other god than me.
"You shall not make yourselves any idols: any images resembling
animals, birds, or fish. You must never bow to an image or worship it in
any way; for I, the Lord your God, am very possessive. I will not share
your affection with any other god!
"And when I punish people for their sins, the punishment continues
upon the children, grandchildren, and great-grandchildren of those who
hate me; but I lavish my love upon thousands of those who love me and
obey my commandments.
"You shall not use the name of Jehovah your God irreverently, nor
use it to swear to a falsehood. You will not escape punishment if you
do.
"Remember to observe the Sabbath as a holy day. Six days a week are
for your daily duties and your regular work, but the seventh day is a
day of Sabbath rest before the lord your God. On that day you are to do
no work of any kind, nor shall your son, daughter, or slaves-whether men
or women-or your cattle or your house gusts. For in six days the Lord
made the heaven, earth, and sea, and everything in them, and rested the
seventh day; so he blessed the Sabbath day and set it aside for rest.
"Honor your father and mother, that you may have a long, good life
in the land the Lord your God will give you.
"You must not murder.
"You must not commit adultery.
"You must not steal.
"You must not lie.
"You must not be envious of your neighbor's house, or want to sleep
with his wife, or want to own his slaves, oxen, donkeys, or anything else
he has."
The above passages were taken from "THE LIVING BIBLE PARAPHRASED".
These are the words spoken by God "Jehovah" and given to Moses on
Mt. Sinai. They are to be obeyed.
Doc-Proc Reference Manual
- 36 -